不会提交 PR 的小伙伴看过来，超详细的视频教程！

| 转载自：海豚调度

| 编辑：钱奕

| 设计：张千禧

| 责编：王玥敏

✎ 编 者 按 

最近有一些新加入社区的朋友反馈不太了解 Apache DolphinScheduler 提交 PR 的步骤和规则。这不，人帅心美的严天奇同学就录制了详细的视频教程，手把手教你提交 PR，不会的小伙伴快上车！

视频教程

大家好，这一期将会向大家介绍如何提交PR。

01

什么是 PR

我们在 Wikipedia 中搜索 pull request，页面直接进入了 Distributed version control 词条中。Pull request 是属于 Distributed version control system 的一个操作，wiki 中介绍到 PR 是为开源仓库做贡献的方式，也可以被称作 merge request。贡献者 request 开源项目维护人员来 pull 贡献者提交的代码改动，所以这个动作被称作 pull request。当贡献的代码改动被通过后，维护人员会merge 贡献者的改动到开源项目中。

02

我们可以从哪些方面提交 PR

绝大多数的代码贡献出发点来自 Apache DolphinScheduler，GitHub 的 issue中，其中会包含 Feature，Bug，Improvement，Test 和 Sub-Task 方向的改动。我们可以根据问题的描述，解决 issue 并进行代码贡献。

作为新手，我建议大家从新手任务开始。

打开 issue， 我们可以看到 pinned issues 里的 good first contributor，官方持续为我们提供了入坑的新手任务，一般新手任务会带有 easy to fix 或 good first issue 标签。

我们可以从列表中选择自己感兴趣的问题，作为第一个 PR 的提交内容。

03

提交 PR 需要注意的点

我们打开官方文档中提交者指南里的 Pull Request 须知。

DolphinScheduler 对 PR 的规范，包括了 PR 标题，PR 分支名，Commit Message 规范，以及 Code Style 配置。

下面我们根据官方文档来学习正确的 PR 规范。

首先是 PR 标题。PR 标题是我们提交 PR 时设置的标题，由[PR 类型-ISSUE 号][模块名]和描述组成，模块名填对应的模块即可。

其次是 PR 分支名 是我们在本地 clone 的项目中新建新的 PR 分支。格式是 Pull Request 类型 -Issue 号。

Commit Message 是我们在提交代码时的提交信息，应该包括三个部分：Header，Body 和 Footer。其中，Header 是必需的，Body 和 Footer 可以省略。

Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和 subject（必需）。

格式为[DS-ISSUE 编号][type] 和 subject。

其他 body footer 部分这里就不赘述，大家可以在 Commit Message 须知进行了解。

稍后我们就按照这个例子来写 Commit Message。

Code-style 按照官方进行配置即可，这样可以保证编码的格式，就不赘述了。

最后，DolphinScheduler 官方建议大家尽量把一个 Pull Request 作为任务的最小粒度进行提交。

Type 用于说明 commit 的类别，是类别的缩写，包括feat for feature，fix，docs，style，refactor，test，chore。

Scope 用于说明 commit 影响的范围，比如 Server、Remote 等；

Subject 是 Commit 目的的简短描述，不超过 50 个字符。

Body 部分是对本次 commit 的详细描述，可以分成多行。

当提交代码与上一个版本不兼容或针对某个 issue 则需要 footer。

下面是一个例子。

xxxx

[DS-001][docs-zh] add commit message

• commit message RIP
• build some conventions
• help the commit messages become clean and tidy
• help developers and release managers better track issues and clarify the optimization in the version iteration

This closes #001

接下来，我来演示如何在  DolphinScheduler 文档中通过纠错单词和错误语法来提交 PR。

比如，如果我们在官网看到关于 DolphinScheduler 的硬件环境中有错误的单词和语法，我们可以自行提交 issue 或者他人发布 issue 来暴露这个问题。

首先，我们找到这个问题的 issue，并留言我们会接管该问题。

接下来分为以下几步：

首先，fork 和 clone 文档项目仓库（因为我们是对官网进行修改，所以需要 fork website 项目，如果需要给 DolphinScheduler 项目提交则换成 DolphinScheduler 项目即可）。接下来是新建分支改动，最后 Push 和提交 PR。

再讲解下详细步骤。首先我们打开 website 的仓库，我们需要在自己的 GitHub 中 fork 官方的 ds-website 项目。

然后我们通过 git clone 克隆 ds-website 项目，如果网络不通的同学可以通过设置 git proxy 来下载。

下载完成之后，我们使用 IDEA 加载项目。这里我已经提前打开了项目。

接着我们新建一个分支，根据前面提到的 PR 分支命名规则设置为 bug-Issue 号, bug-6939。

我们需要找到硬件环境（https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/hardware.html）这篇文章，首先找到对应的版本 2.0.0，再找到 url 中对应的 hardware.html 文件在 /user_doc/guide/installation 文件夹下。

接着我们对错误的单词和语法进行修正。

所有的改动结束之后，我们需要先 commit 这次的改动并根据官方要求填写Commit Message。

再将分支 push 到我们的 GitHub 中。

最后，GitHub 提示我们的改动可以提交 PR，点击 compare & pull request 提交 PR 并按照官方要求描述 PR 标题。

这样，我们的 PR 就提交好了！后续如果有任何改动依然可以对该分支进行提交。

提交 PR 的后续：

• 社区 Committer 们会做 CodeReview，再与您讨论一些细节（包括设计，实现，性能等）和可能需要更改的部分。当团队对本次修改满意后，会将提交合并到 dev 分支；
• 最后，恭喜您已经成为了 DolphinScheduler 的官方贡献者。

看到这里，你学会了吗？如果您也想参与贡献，下面有各种问题汇总👇👇👇👇

参与贡献

随着国内开源的迅猛崛起，Apache DolphinScheduler 社区迎来蓬勃发展，为了做更好用、易用的调度，真诚欢迎热爱开源的伙伴加入到开源社区中来，为中国开源崛起献上一份自己的力量，让本土开源走向全球。

参与 DolphinScheduler 社区有非常多的参与贡献的方式，包括：

贡献第一个PR(文档、代码) 我们也希望是简单的，第一个PR用于熟悉提交的流程和社区协作以及感受社区的友好度。

社区汇总了以下适合新手的问题列表：https://github.com/apache/dolphinscheduler/issues/5689

非新手问题列表：https://github.com/apache/dolphinscheduler/issues?q=is%3Aopen+is%3Aissue+label%3A%22volunteer+wanted%22

如何参与贡献链接：https://dolphinscheduler.apache.org/zh-cn/docs/development/contribute.html

来吧，DolphinScheduler开源社区需要您的参与，为中国开源崛起添砖加瓦吧，哪怕只是小小的一块瓦，汇聚起来的力量也是巨大的。

参与开源可以近距离与各路高手切磋，迅速提升自己的技能，如果您想参与贡献，我们有个贡献者种子孵化群，可以添加社区小助手

微信(Leonard-ds) 手把手教会您( 贡献者不分水平高低，有问必答，关键是有一颗愿意贡献的心 )。添加小助手微信时请说明想参与贡献。

来吧，开源社区非常期待您的参与。

相关阅读 | Related Reading

毕业一年，我是如何成为Apache项目的Committer

开源软件的痛点

ALC Shenzhen 官宣正式成立了！

开源社简介

开源社成立于 2014 年，是由志愿贡献于开源事业的个人成员，依 “贡献、共识、共治” 原则所组成，始终维持厂商中立、公益、非营利的特点，是最早以 “开源治理、国际接轨、社区发展、开源项目” 为使命的开源社区联合体。开源社积极与支持开源的社区、企业以及政府相关单位紧密合作，以 “立足中国、贡献全球” 为愿景，旨在共创健康可持续发展的开源生态，推动中国开源社区成为全球开源体系的积极参与及贡献者。

2017 年，开源社转型为完全由个人成员组成，参照 ASF 等国际顶级开源基金会的治理模式运作。近七年来，链接了数万名开源人，集聚了上千名社区成员及志愿者、海内外数百位讲师，合作了近百家赞助、媒体、社区伙伴。